<?php
/*
 * @Descripttion: 
 * @version: 1.0
 * @Author: Sam
 * @Date: 2022-03-07 15:51:01
 * @LastEditors: Sam
 * @LastEditTime: 2022-03-11 11:19:17
 */

return [
    // 文档标题
    'title'              => 'APi接口文档',
    // 文档描述
    'desc'               => '接口域名：https://game.vrupup.com/sanguo/XXX/index.php',
    // 默认请求类型
    'default_method'=>'GET',
    // 默认作者
    'default_author'=>'Sam',
    // 允许跨域访问
    'allowCrossDomain'=>true,
    // 是否禁止接口调试
    'notDebug'=>false,
    // 设置可选版本
    'apps'           => [

        [
            'title'=>'API在线接口文档',
            'path'=>'app\api\controller',
            'folder'=>'api'
        ]
    ],
    // 自动生成url回调函数
    'auto_url' => [
//        'custom' =>function($class,$method){
//            return "/".str_replace('\\','/',$class).$method;
//        },
        // 字母规则
        'letter_rule' => "",
        // 多级路由分隔符
        'multistage_route_separator'  =>"."

    ],
    // 指定公共注释定义的文件地址
    'definitions'        => "app\common\controller\Definitions",
    // 缓存配置
    'cache'              => [
        // 是否开启缓存
        'enable' => false,
    ],
    // 权限认证配置
    'auth'               => [
        // 是否启用密码验证
        'enable'     => true,
        // 全局访问密码
        'password'   => "123456",
        // 密码加密盐
        'secret_key' => "apidoc#wckj",
        // 有效期
        'expire' => 3*24*60*60
    ],
    // 统一的请求Header
    'headers'=>[
//        ['name'=>'Authorization','type'=>'string','require'=>true,'desc'=>'lang(apidoc.config.headers.Authorization)'],
    ],
    // 统一的请求参数Parameters
    'parameters'=>[],
    // 统一的请求响应体
    'responses'=>[
        ['name'=>'code','desc'=>'1,成功，0失败','type'=>'int'],
        ['name'=>'msg','desc'=>'描述信息或报错信息','type'=>'string'],
        ['name'=>'data','desc'=>'返回数据','main'=>true,'type'=>'object'],
    ],



];
